<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>字典相关方法 | vue2-element-dict</title>
    <meta name="generator" content="VuePress 1.9.7">
    <link rel="icon" href="/vue2-element-dict/favicon.ico">
    <script defer="defer" async="async" src="https://cpro.baidustatic.com/cpro/ui/cm.js"></script>
    <meta name="description" content="vue2-element-dict字典包官方使用文档">
    
    <link rel="preload" href="/vue2-element-dict/assets/css/0.styles.4793a278.css" as="style"><link rel="preload" href="/vue2-element-dict/assets/js/app.b15cbcb6.js" as="script"><link rel="preload" href="/vue2-element-dict/assets/js/4.26f72541.js" as="script"><link rel="preload" href="/vue2-element-dict/assets/js/31.99cbdf15.js" as="script"><link rel="prefetch" href="/vue2-element-dict/assets/js/1.de614e96.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/10.2f2bf95a.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/11.ff41966b.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/12.b8277606.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/13.b04a73f4.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/14.4d6242d1.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/15.630dac4e.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/16.a7c1d843.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/17.2b8a9633.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/18.8eb3630c.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/19.6786c2bb.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/2.53443f2d.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/20.a5157105.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/21.d4d5c2c2.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/22.8b3228db.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/23.c5c8d87f.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/24.fccc0622.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/25.01db42e3.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/26.faa5aea5.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/27.80a1c84f.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/28.a9a8221b.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/29.2fcd2f4e.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/30.dd694ba1.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/32.1fb6dad3.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/33.7b640408.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/34.1c4b9978.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/35.a2561dd0.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/36.c02c0325.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/37.f5704977.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/5.0ef459b8.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/6.d8b0c3f6.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/7.08430ef6.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/8.d5c78b56.js"><link rel="prefetch" href="/vue2-element-dict/assets/js/9.cbf8f2c2.js">
    <link rel="stylesheet" href="/vue2-element-dict/assets/css/0.styles.4793a278.css">
  </head>
  <body>
    <div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/vue2-element-dict/" class="home-link router-link-active"><!----> <span class="site-name">vue2-element-dict</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/vue2-element-dict/" class="nav-link">
  主页
</a></div><div class="nav-item"><a href="/vue2-element-dict/guide/" class="nav-link">
  指南
</a></div><div class="nav-item"><a href="https://www.npmjs.com/package/vue2-element-dict" target="_blank" rel="noopener noreferrer" class="nav-link external">
  npm地址
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/vue2-element-dict/" class="nav-link">
  主页
</a></div><div class="nav-item"><a href="/vue2-element-dict/guide/" class="nav-link">
  指南
</a></div><div class="nav-item"><a href="https://www.npmjs.com/package/vue2-element-dict" target="_blank" rel="noopener noreferrer" class="nav-link external">
  npm地址
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div> <!----></nav>  <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>捐赠</span> <!----></p> <!----></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>指南</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue2-element-dict/guide/" class="sidebar-link">介绍</a></li><li><a href="/vue2-element-dict/guide/fast/" class="sidebar-link">快速开始</a></li><li><a href="/vue2-element-dict/guide/directory-structure/" class="sidebar-link">目录结构</a></li><li><a href="/vue2-element-dict/guide/config/" class="sidebar-link">字典包配置</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>普通字典组件</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue2-element-dict/components/el-select-dict/" class="sidebar-link">select-dict选择器</a></li><li><a href="/vue2-element-dict/components/el-radio-dict/" class="sidebar-link">radio-dict单选框</a></li><li><a href="/vue2-element-dict/components/el-checkbox-dict/" class="sidebar-link">checkbox-dict多选框</a></li><li><a href="/vue2-element-dict/components/el-radio-button-dict/" class="sidebar-link">radio-button-dict单选框</a></li><li><a href="/vue2-element-dict/components/el-checkbox-button-dict/" class="sidebar-link">checkbox-button-dict多选框</a></li><li><a href="/vue2-element-dict/components/el-tabs-dict/" class="sidebar-link">tabs-dict标签页</a></li><li><a href="/vue2-element-dict/components/el-tag-dict/" class="sidebar-link">tag-dict标签</a></li><li><a href="/vue2-element-dict/components/el-link-dict/" class="sidebar-link">link-dict链接</a></li><li><a href="/vue2-element-dict/components/el-text-dict/" class="sidebar-link">text-dict链接</a></li><li><a href="/vue2-element-dict/components/el-button-dict/" class="sidebar-link">button-dict链接</a></li><li><a href="/vue2-element-dict/components/el-table-colmun-dict/" class="sidebar-link">el-table-colmun-dict表格</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>树形字典组件</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue2-element-dict/components/el-cascader-dict/" class="sidebar-link">cascader-dict联级选项</a></li><li><a href="/vue2-element-dict/components/el-tree-dict/" class="sidebar-link">tree-dict树菜单</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>过滤器</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue2-element-dict/filters/dict/" class="sidebar-link">字典过滤器</a></li><li><a href="/vue2-element-dict/filters/tree-dict/" class="sidebar-link">树形字典过滤器</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>方法</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue2-element-dict/functions/dict/" aria-current="page" class="active sidebar-link">字典方法</a></li><li><a href="/vue2-element-dict/functions/other/" class="sidebar-link">其他方法</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="字典相关方法"><a href="#字典相关方法" class="header-anchor">#</a> 字典相关方法</h1> <p>字典相关方法均为promise方式调用，因为当缓存中无该字典类型时，会发起请求字典接口的动作，为了兼容此情况，不得不使用promise的形式。字典相关方法如下</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token comment">/**
 * @description: 通过字典code获取字典label
 * @param val 字典code
 * @param dictType 字典类型
 * @param defaultVal 配置当找不到该字典类型的值时展示默认值
 * @return {Promise()    label}
 * @author: syx
 */</span>
<span class="token function">getLabelByCode</span><span class="token punctuation">(</span>val<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> defaultVal <span class="token operator">=</span> <span class="token string">&quot;&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token comment">/**
 * @description: 通过字典label获取字典code
 * @param val 字典label
 * @param dictType 字典类型
 * @param defaultVal 配置当找不到该字典类型的值时展示默认值
 * @return {Promise()    code}
 * @author: syx
 */</span>
<span class="token function">getCodeByLabel</span><span class="token punctuation">(</span>val<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> defaultVal <span class="token operator">=</span> <span class="token string">&quot;&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token comment">/**
 * @description: 通过字典多个code获取字典多个label
 * @param vals 字典多个 code
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个code找不到值时 展示的默认值
 *  formatFun(arr, format)  arr为该字典类型中找到的多个code的对象组合， format为字典包配置的format 包含label和value字段。 默认函数为返回label英文逗号分隔
 *  spacer 间隔符，为配置vals中多个code之间的间隔符
 * }
 * @return {Promise()    label1,label2}
 * @author: syx
 */</span>
<span class="token function">getLabelByCodes</span><span class="token punctuation">(</span>vals<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> options<span class="token punctuation">)</span>

<span class="token comment">/**
 * @description: 通过字典多个label获取字典多个code
 * @param vals 字典多个 label
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个label找不到值时 展示的默认值
 *  formatFun(arr, format)  arr为该字典类型中找到的多个code的对象组合， format为字典包配置的format 包含label和value字段。 默认函数为返回code英文逗号分隔
 *  spacer 间隔符，为配置vals中多个label之间的间隔符
 * }
 * @return {Promise()    code1,code2}
 * @author: syx
 */</span>
<span class="token function">getCodeByLabels</span><span class="token punctuation">(</span>vals<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> options<span class="token punctuation">)</span>

<span class="token comment">/**
 * @description: 通过传递字典类型，返回该字典类型的数据
 * @param dictTypes 可传数组形式，或者字符串英文逗号隔开 如 [&quot;sex&quot;, &quot;color&quot;]  &quot;sex,color&quot;
 * @return {Promise()    {sex: [], color: []}}
 * @author: syx
 */</span>
<span class="token function">getDictObjByDictTypes</span><span class="token punctuation">(</span>dictTypes<span class="token punctuation">)</span>

<span class="token comment">/**
 * @description: 通过字典code获取字典label
 * @param val 字典code
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal code找不到值时 展示的默认值
 *  formatFun(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合， treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回label英文逗号分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 * }
 * @return {Promise()    label,label,label}
 * @author: syx
 */</span>
<span class="token function">getTreeLabelByCode</span><span class="token punctuation">(</span>val<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> options<span class="token punctuation">)</span>

<span class="token comment">/**
 * @description: 通过字典label获取字典code
 * @param val 字典label
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal label找不到值时 展示的默认值
 *  formatFun(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合， treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回code英文逗号分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 * }
 * @return {Promise()    code,code,code}
 * @author: syx
 */</span>
<span class="token function">getTreeCodeByLabel</span><span class="token punctuation">(</span>val<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> options<span class="token punctuation">)</span>

<span class="token comment">/**
 * @description: 通过多个字典code获取多个字典label
 * @param vals 多个字典code
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个codel找不到值时 展示的默认值
 *  formatFunIn(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合， treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回label &quot;/&quot;分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 *  formatFunOut (arr) arr为多个label的数组  默认return arr.join(&quot;,&quot;)
 *  spacer 间隔符，为配置vals中多个label之间的间隔符
 * }
 * @return {Promise()    label1/label11/label111,label2/label22/label222}
 * @author: syx
 */</span>
<span class="token function">getTreeLabelByCodes</span><span class="token punctuation">(</span>vals<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> options<span class="token punctuation">)</span>

<span class="token comment">/**
 * @description: 通过多个字典label获取多个字典code
 * @param vals 多个字典label
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个codel找不到值时 展示的默认值
 *  formatFunIn(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合， treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回code &quot;/&quot;分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 *  formatFunOut (arr) arr为多个code的数组  默认return arr.join(&quot;,&quot;)
 *  spacer 间隔符，为配置vals中多个label之间的间隔符
 * }
 * @return {Promise()    code1/code11/code111,code2/code22/code222}
 * @author: syx
 */</span>
<span class="token function">getTreeCodeByLabels</span><span class="token punctuation">(</span>vals<span class="token punctuation">,</span> dictType<span class="token punctuation">,</span> options<span class="token punctuation">)</span></code></pre></div></div> <footer class="page-edit"><!----> <div class="last-updated"><span class="prefix">上次更新:</span> <span class="time">5/12/2023, 9:02:27 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
      ←
      <a href="/vue2-element-dict/filters/tree-dict/" class="prev">
        树形字典过滤器
      </a></span> <span class="next"><a href="/vue2-element-dict/functions/other/">
        其他方法
      </a>
      →
    </span></p></div> </main></div><div class="global-ui"><div id="loading-mask"><div class="loading-wrapper"><span class="loading-dot loading-dot-spin"><i></i> <i></i> <i></i> <i></i></span></div></div><!----></div></div>
    <script src="/vue2-element-dict/assets/js/app.b15cbcb6.js" defer></script><script src="/vue2-element-dict/assets/js/4.26f72541.js" defer></script><script src="/vue2-element-dict/assets/js/31.99cbdf15.js" defer></script>
  </body>
</html>
